home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / tex / cs_tex_4 / cstex4_2.zoo / makeindx.lzh / MAKEINDX / MAKEINDX.MAN < prev    next >
Text File  |  1991-09-10  |  23KB  |  495 lines
  1. MAKEINDEX
  2.  
  3. NAME
  4.      makeindex - a general purpose,  formatter-independent  index
  5.      processor
  6.  
  7. SYNOPSIS
  8.      makeindex [-ilqrc] [-s sty] [-o ind] [-t log] [-p no] [ idx0
  9.      idx1 idx2 ...]
  10.  
  11. DESCRIPTION
  12.      makeindex is a general purpose index  processor.   It  takes
  13.      one  or  more  raw index files (normally generated by a for-
  14.      matter), sorts the entries, and produces  the  actual  index
  15.      file.   It  is not dependent on any particular format of raw
  16.      index file, although the .idx file generated by  is default.
  17.      Up  to  three levels (0, 1, and 2) of subitem nesting within
  18.      the same entry is supported.  The input format may be  rede-
  19.      fined  in  a style file so that raw index or glossary output
  20.      from other formatters may be processed.  The style file also
  21.      defines  the  style  of output index file.  Unless specified
  22.      otherwise, the file name base of the first input file (idx0)
  23.      is  used to determine other related input/output files.  For
  24.      each input file name specified, the  name  itself  is  first
  25.      used.   If  not found and the name has no extension part, it
  26.      is concatenated with the  .idx  extension.   If  this  again
  27.      fails, the program aborts.
  28.  
  29. OPTIONS
  30.      -i        Use stdin as the input file.  When this option  is
  31.                specified  and the -o is not, output is written to
  32.                stdout.
  33.  
  34.      -l        Use letter ordering.   Default  is  word  ordering
  35.                (explained in the ORDERING section).
  36.  
  37.      -q        Quiet  mode,  send  no  messages  to  stderr.   By
  38.                default  progress  and  error messages are sent to
  39.                stderr as well as the  transcript  file.   The  -q
  40.                option disables the stderr messages.
  41.  
  42.      -r        Disable implicit page range formation.  By default
  43.                three  or  more successive pages will be automati-
  44.                cally abbreviated as a range (e.g. 1--5).  The  -r
  45.                option  disables  it,  making  the  explicit range
  46.                operators the only way to create page ranges  (see
  47.                the SPECIAL EFFECTS section below).
  48.  
  49.      -c        Enable blank compression.  By default every  blank
  50.                counts  in  the  index key.  The -c option ignores
  51.                leading  and  trailing   blanks   and   tabs   and
  52.                compresses intermediate ones to a single space.
  53.  
  54.      -s sty    Take sty as the style file.  There is  no  default
  55.                for the style file name.  The environment variable
  56.                INDEXSTYLE defines the path where the  style  file
  57.                should be found.
  58.  
  59.      -o ind    Take ind as the output index file.  By default the
  60.                file  name  base of the first input file idx0 con-
  61.                catenated with the extension .ind is used  as  the
  62.                output file name.
  63.  
  64.      -t log    Take log as the transcript file.  By  default  the
  65.                file  name  base of the first input file idx0 con-
  66.                catenated with the extension .ilg is used  as  the
  67.                transcript file name.
  68.  
  69.      -p no     Set the starting page number of the  output  index
  70.                file to be no.  This is useful when the index file
  71.                is to be formatted separately.   Other  than  pure
  72.                numbers,  three  special cases are allowed for no:
  73.                any, odd, and even.  In these special  cases,  the
  74.                starting  page  number is determined by retrieving
  75.                the last page number from  the  source  log  file.
  76.                The  source  log  file  name is determined by con-
  77.                catenating the file name base  of  the  first  raw
  78.                index  file  (idx0)  with the extension .log.  The
  79.                last source page is obtained by searching backward
  80.                in the log file for the first instance of a number
  81.                included in [...].  If a page number is missing or
  82.                the log file is not found, no attempt will be made
  83.                to set the starting page number.  The  meaning  of
  84.                each of these cases follows.
  85.  
  86.                any       The starting page  is  the  last  source
  87.                          page number plus 1.
  88.  
  89.                odd       The starting page is the first odd  page
  90.                          following the last source page number.
  91.  
  92.                even      The starting page is the first even page
  93.                          following the last source page number.
  94.  
  95. STYLE FILE
  96.      The style file format is very  simple.   It  is  a  list  of
  97.      <specifier,  attribute>  pairs.   There  are  two  types  of
  98.      specifiers (input and output).  The pairs don't have to obey
  99.      any  particular  order  in the file. A line lead by `%' is a
  100.      comment.  The following is a list of all the specifiers  and
  101.      their  respective  arguments  where <string> is an arbitrary
  102.      string delimited by double quotes ("..."), <char> is a  sin-
  103.      gle  letter  embraced by single quotes ('...'), and <number>
  104.      is a nonnegative integer.  The maximum length of a  <string>
  105.      is  144.   Notice  that  a  backslash must be escaped (by an
  106.      extra backslash) in  the  string  quotation.   Anything  not
  107.      specified  in  the  style  file  will  be assigned a default
  108.      value, which is shown at the rightmost  column.   This  file
  109.      can  reside  anywhere in the path defined by the environment
  110.      variable INDEXSTYLE.
  111.  
  112.      % Input Style Specifiers
  113.  
  114.      keyword  <string>             "\\indexentry"
  115.                                    This  is  the  command   which
  116.                                    tells makeindex that its argu-
  117.                                    ment is an index entry.
  118.  
  119.      arg_open  <char>              '{'
  120.                                    This is the opening  delimiter
  121.                                    for the index entry argument.
  122.  
  123.      arg_close  <char>             '}'
  124.                                    This is the closing  delimiter
  125.                                    for the index entry argument.
  126.  
  127.      range_open  <char>            '('
  128.                                    The opening delimiter indicat-
  129.                                    ing the beginning of an expli-
  130.                                    cit page range.
  131.  
  132.      range_close  <char>           ')'
  133.                                    The closing delimiter indicat-
  134.                                    ing  the  end  of  an explicit
  135.                                    page range.
  136.  
  137.      level  <char>                 '!'
  138.                                    The delimiter which denotes  a
  139.                                    new level of subitem.
  140.  
  141.      actual  <char>                '@'
  142.                                    The  symbol  which   indicates
  143.                                    that  the  next  entry  is  to
  144.                                    appear  in  the  actual  index
  145.                                    file.
  146.  
  147.      encap  <char>                 '|'
  148.                                    The  symbol  which   indicates
  149.                                    that  the rest of the argument
  150.                                    list is  to  be  used  as  the
  151.                                    encapsulating  command for the
  152.                                    page number.
  153.  
  154.      quote  <char>                 '"'
  155.  
  156.      escape  <char>                '\\'
  157.                                    The symbol which  escapes  the
  158.                                    next    letter,   unless   its
  159.                                    preceding  letter  is  escape.
  160.                                    In  other words, quote is used
  161.                                    to  escape  the  letter  whcih
  162.                                    immediately  follows  it.  But
  163.                                    if it is preceded  by  escape,
  164.                                    it  does  not escape anything.
  165.                                    Notice that  the  two  symbols
  166.